FHIR © HL7.org  |  Server Home  |  FHIR Server FHIR Server 3.4.11  |  FHIR Version n/a  User: [n/a]

Resource CapabilityStatement/FHIR Server from package hl7.fhir.uv.ipa#current (172 ms)

Package hl7.fhir.uv.ipa
Type CapabilityStatement
Id Id
FHIR Version R4
Source http://hl7.org/fhir/uv/ipa/https://build.fhir.org/ig/HL7/fhir-ipa/CapabilityStatement-ipa-client.html
Url http://hl7.org/fhir/uv/ipa/CapabilityStatement/ipa-client
Version 1.1.0
Status active
Date 2023-11-14
Name InternationalPatientAccessClientAPI
Title International Patient Access Client CapabilityStatement
Experimental False
Realm uv
Authority hl7
Description This CapabilityStatement describes the basic rules for the International Patient Access client actor that initiates a data access request to and retrieves patient data from an IPA Responder. In addition, it lists the client conformance expectations for each resource type documented in IPA. These expectations include supported FHIR profiles, RESTful operations, and search parameters. International Patient Access clients define their capabilities by choosing from this list based on the resource types they need to access.
Copyright Used by permission of HL7 International all rights reserved Creative Commons License
Kind requirements

Resources that use this resource

No resources found


Resources that this resource uses

ImplementationGuide
http://hl7.org/fhir/smart-app-launch/ImplementationGuide/hl7.fhir.uv.smart-app-launch SMART App Launch
http://hl7.org/fhir/uv/ipa/OperationDefinition/docref IPA Fetch DocumentReference
http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-allergyintolerance IPA-AllergyIntolerance
http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-condition IPA-Condition
http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-documentreference IPA-DocumentReference
http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-immunization IPA-Immunization
http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medication IPA-Medication
http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medicationrequest IPA-MedicationRequest
http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medicationstatement IPA-MedicationStatement
http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-observation IPA-Observation
http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patient IPA-Patient
http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitioner IPA-Practitioner
http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitionerrole IPA-PractitionerRole
http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-problem-list-item IPA-problem-list-item


Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: CapabilityStatement ipa-client

International Patient Access Client CapabilityStatement

  • Implementation Guide Version: 1.1.0
  • FHIR Version: 4.0.1
  • Supported Formats: SHALL support json, SHOULD support xml
  • Supported Patch Formats: SHOULD support application/json-patch+json
  • Published on: 2023-11-14
  • Published by: HL7 International / Patient Care

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

SHALL Support the Following Implementation Guides

FHIR RESTful Capabilities

Mode: client

The IPA Client SHALL:

  1. Support the IPA conformance expectations for the Patient resource profile.
  2. Support the IPA conformance expectations for each IPA resource type they support
  3. Implement the RESTful behavior according to the FHIR specification.
  4. Support JSON source formats for all IPA interactions.

The IPA Client SHOULD:

  1. For the purposes of safety, specify the patient id when searching other resources.
Security
  1. See the General Security Considerations section for requirements and recommendations.
Summary of System-wide Interactions
  • MAY support the transactioninteraction.
  • MAY support the batchinteraction.
  • MAY support the search-systeminteraction.
  • MAY support the history-systeminteraction.

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
AllergyIntolerancehttp://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-allergyintoleranceyyclinical-status, patient, patient+clinical-statusProvenance:target
Conditionhttp://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-condition
Additional supported profiles:
  IPA-problem-list-item
yycategory, clinical-status, verification-status, code, onset-date, patient, patient+clinical-status, patient+category, patient+category+clinical-status, patient+code, patient+onset-dateProvenance:target
DocumentReferencehttp://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-documentreferenceyy_id, category, contenttype, date, period, status, type, patient, patient+category, patient+category+date, patient+type, patient+contenttype, patient+status, patient+type+date, patient+type+periodProvenance:target$docref
Immunizationhttp://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-immunizationyydate, status, patient, patient+date, patient+statusProvenance:target
Medicationhttp://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medicationyProvenance:target
MedicationRequesthttp://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medicationrequestyycategory, code, authoredon, intent, status, patient, patient+intent, patient+intent+authoredon, patient+intent+statusMedicationRequest:medicationProvenance:target
MedicationStatementhttp://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medicationstatementyystatus, patient, patient+statusMedicationStatement:medicationProvenance:target
Observationhttp://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-observation
Additional supported profiles:
  Vital Signs Profile
yycategory, code, date, status, patient, patient+category, patient+code, patient+category+date, patient+category+status, patient+code+dateProvenance:target
Patienthttp://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patientyy_id, birthdate, family, gender, given, identifier, name, family+gender, birthdate+family, birthdate+name, gender+nameProvenance:target
Practitionerhttp://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitioneryProvenance:target
PractitionerRolehttp://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitionerroleyPractitionerRole:endpoint, PractitionerRole:practitionerProvenance:target

Resource Conformance: SHOULD AllergyIntolerance

Base System Profile
IPA-AllergyIntolerance
Profile Conformance
SHALL
Reference Policy
resolves

Interaction summary
  • SHALL support read, search-type.

Documentation

If the client supports the AllergyIntolerance resource, the client SHALL support the IPA profile and the conformance expectations for the AllergyIntolerance resource.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

The client SHALL provide at least a id value and MAY provide both the Type and id values. The server SHALL support both.

MAYclinical-statustoken

active | inactive | resolved

Combined Search Parameters
ConformanceParametersTypes
SHOULDpatient+clinical-statusreference+token

Resource Conformance: SHOULD Condition

Base System Profile
IPA-Condition
Profile Conformance
SHALL
Reference Policy
resolves

Supported Profiles

IPA-problem-list-item

Interaction summary
  • SHALL support read, search-type.

Documentation

If the client supports the Condition resource, the client SHALL support the IPA profile and the conformance expectations for the Condition resource.

Client applications should be prepared to encounter codes they do not recognize and handle the records accordingly. Servers SHOULD populate Condition.code.coding.display and/or Condition.code.text so that clients can always at least display the condition even if they do not know the codes that are used. Clients should be careful making use of the code search parameter given that the codes used vary so much.

Safety Issues:

  • Clients SHALL not treat all conditions as if they are part of the patient's current problem list
    • Note that some Condition resources may not have these status codes - this is usually due to poor record keeping reflected in legacy data
    • Servers SHOULD avoid leaving these status codes missing
  • Clients SHALL pay attention to the clinicalStatus and verificationStatus and display and process them correctly * Clients SHALL still work safely when the server does not support all the search parameters listed here.
Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

The client SHALL provide at least a id value and MAY provide both the Type and id values. The server SHALL support both.

MAYcategorytoken

The category of the condition

MAYclinical-statustoken

The clinical status of the condition

MAYverification-statustoken

The verification status of the condition

MAYcodetoken

Code for the condition

MAYonset-datedate

Date of onset for the condition

Combined Search Parameters
ConformanceParametersTypes
SHOULDpatient+clinical-statusreference+token
SHOULDpatient+categoryreference+token
SHOULDpatient+category+clinical-statusreference+token+token
SHOULDpatient+codereference+token
SHOULDpatient+onset-datereference+date

Resource Conformance: SHOULD DocumentReference

Base System Profile
IPA-DocumentReference
Profile Conformance
SHALL
Reference Policy
resolves

Interaction summary
  • SHALL support read, search-type.

Documentation

If the client supports the DocumentReference resource, the client SHALL support the IPA profile and the conformance expectations for the DocumentReference resource.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

The client SHALL provide at least an id value and MAY provide both the Type and id values. The server SHALL support both.

SHOULD_idtoken
MAYcategorytoken

Categorization of document

MAYcontenttypetoken

Mime type of the content, may include charset

MAYdatedate

When this document reference was created

MAYperioddate

Time of service that is being documented

MAYstatustoken

current | superseded | entered-in-error

MAYtypetoken

Kind of document (LOINC if possible)

Combined Search Parameters
ConformanceParametersTypes
SHOULDpatient+categoryreference+token
SHOULDpatient+category+datereference+token+date
SHOULDpatient+typereference+token
SHOULDpatient+contenttypereference+token
SHOULDpatient+statusreference+token
SHOULDpatient+type+datereference+token+date
SHOULDpatient+type+periodreference+token+date
Extended Operations
ConformanceOperationDocumentation
SHOULD$docref

A client SHOULD be capable of transacting a $docref operation and capable of accessing the document using the using the link provided in the DocumentReference.content.attachment.url element.

Resource Conformance: SHOULD Immunization

Base System Profile
IPA-Immunization
Profile Conformance
SHALL
Reference Policy
resolves

Interaction summary
  • SHALL support read, search-type.

Documentation

If the client supports the Immunization resource, the client SHALL support the IPA profile and the conformance expectations for the Immunization resource.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

The client SHALL provide at least an id value and MAY provide both the Type and id values. The server SHALL support both.

MAYdatedate

Vaccination (non)-Administration Date

MAYstatustoken

Immunization event status

Combined Search Parameters
ConformanceParametersTypes
SHOULDpatient+datereference+date
SHOULDpatient+statusreference+token

Resource Conformance: SHOULD Medication

Base System Profile
IPA-Medication
Profile Conformance
SHALL
Reference Policy
resolves

Interaction summary
  • SHALL support read.

Documentation

If the client supports the the MedicationStatement or MedicationRequest resource, the client SHALL support the IPA profile and the conformance expectations for the Medication resource.

Resource Conformance: SHOULD MedicationRequest

Base System Profile
IPA-MedicationRequest
Profile Conformance
SHALL
Reference Policy
resolves

Interaction summary
  • SHALL support read, search-type.

Documentation

If the client supports the MedicationRequest resource, the client SHALL support the IPA profile and the conformance expectations for the MedicationStatement, MedicationRequest and Medication resource.

Clients SHALL query for both MedicationStatement and MedicationRequest when fetching patient Medication information.

The MedicationRequest resources can represent a medication using either a code or refer to the Medication resource. When referencing Medication, the resource may be contained or an external resource. The server application MAY choose any one way or more than one method, but if an external reference to Medication is used, the server SHALL support the _include parameter for searching this element. The client application SHALL support all methods. For example, A server SHALL be capable of returning all medications for a patient using one of or both:

GET /MedicationStatement?patient=[id]

GET /MedicationStatement?patient=[id]&_include=MedicationStatement:medication

When representing a prescribed medication, servers SHOULD use codings at the level of a clinical drug rather than ingredient or dose form (e.g. "loratadine 10mg oral tablet", rather than a bare ingredient like "loratadine" or a dose form like "loratadine oral tablet").

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

The client SHALL provide at least an id value and MAY provide both the Type and id values. The server SHALL support both.

SHOULDcategorytoken

Returns prescriptions with different categories

SHOULDcodetoken

Return prescriptions of this medication code

MAYauthoredondate

Returns prescriptions written on this date

MAYintenttoken

Return prescriptions with this encounter identifier

MAYstatustoken

Status of the prescription

Combined Search Parameters
ConformanceParametersTypes
SHOULDpatient+intentreference+token
SHOULDpatient+intent+authoredonreference+token+date
SHOULDpatient+intent+statusreference+token+token

Resource Conformance: SHOULD MedicationStatement

Base System Profile
IPA-MedicationStatement
Profile Conformance
SHALL
Reference Policy
resolves

Interaction summary
  • SHALL support read, search-type.

Documentation

If the client supports the MedicationStatement resource, the client SHALL support the IPA profile and the conformance expectations for the MedicationStatement, MedicationRequest and Medication resource.

Clients SHALL query for both MedicationStatement and MedicationRequest when fetching patient Medication information.

The MedicationStatement resources can represent a medication using either a code or refer to the Medication resource. When referencing Medication, the resource may be contained or an external resource. The server application MAY choose any one way or more than one method, but if an external reference to Medication is used, the server SHALL support the _include parameter for searching this element. The client application SHALL support all methods.For example, A server SHALL be capable of returning all medications for a patient using one of or both:

GET /MedicationStatement?patient=[id]

GET/MedicationStatement?patient=[id]&_include=MedicationStatement:medication

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

The client SHALL provide at least an id value and MAY provide both the Type and id values.

MAYstatustoken

Return statements that match the given status

Combined Search Parameters
ConformanceParametersTypes
SHOULDpatient+statusreference+token

Resource Conformance: SHOULD Observation

Base System Profile
IPA-Observation
Profile Conformance
SHALL
Reference Policy
resolves

Supported Profiles

Vital Signs Profile

Interaction summary
  • SHALL support read, search-type.

Documentation

If the client supports the Observation resource, the client SHALL support the IPA profile and the conformance expectations for the Observation resource.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

The client SHALL provide at least an id value and MAY provide both the Type and id values. The server SHALL support both.

MAYcategorytoken

The classification of the type of observation

MAYcodetoken

The code of the observation type

MAYdatedate

Obtained date/time. If the obtained element is a period, a date that falls in the period

MAYstatustoken

The status of the observation

Combined Search Parameters
ConformanceParametersTypes
SHOULDpatient+categoryreference+token
SHOULDpatient+codereference+token
SHOULDpatient+category+datereference+token+date
SHOULDpatient+category+statusreference+token+token
SHOULDpatient+code+datereference+token+date

Resource Conformance: SHALL Patient

Base System Profile
IPA-Patient
Profile Conformance
SHALL
Reference Policy
resolves

Interaction summary
  • SHALL support read, search-type.

Documentation

Client applications SHALL be able to access the patient record using the following API call:

GET [url]/Patient/[id]

Client application MAY use these search parameters that servers are required to support to access the patient record:

  • _id
  • identifier

Servers are not required to support any additional search parameters, and clients SHOULD not expect servers to do so.

Additional rules and guidance for supporting Patient.link:

  • The server:
    • SHALL have no more than one Patient with a status of active = "true" from the server being queried
    • MAY include inactive patients on the same server
    • MAY include inactive or active patients from a different server
    • When returning a search Bundle that contains more than one Patient record for the same patient, the Patient record(s) SHALL use the Patient.link attribute to cross-link the Patient resources.
  • The client:
    • SHALL be able to follow the link(s) to the other Patient resource(s) and understand the direction of the link (in other words, which Patient is linked to which other Patient)
    • SHALL understand the Patient.link.type code which defines the type of link between this Patient resource and another Patient resource
    • SHALL be aware of the linked Patient active flag and that inactive patients may have relevant information
Search Parameters
ConformanceParameterTypeDocumentation
SHOULD_idtoken
SHOULDbirthdatedate

A client SHALL provide a value precise to the day. A server SHALL support a value a value precise to the day.

SHOULDfamilystring
SHOULDgendertoken

The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both.

SHOULDgivenstring
SHOULDidentifiertoken

The client SHALL provide both the system and code values. The server SHALL NOT support only code values.

SHOULDnamestring
Combined Search Parameters
ConformanceParametersTypes
SHOULDfamily+genderstring+token
SHOULDbirthdate+familydate+string
SHOULDbirthdate+namedate+string
SHOULDgender+nametoken+string

Resource Conformance: SHOULD Practitioner

Base System Profile
IPA-Practitioner
Profile Conformance
SHALL
Reference Policy
resolves

Interaction summary
  • SHALL support read.

Documentation

If the client supports the Practitioner resource, the client SHALL support the IPA profile and the conformance expectations for the Practitioner resource.

Resource Conformance: SHOULD PractitionerRole

Base System Profile
IPA-PractitionerRole
Profile Conformance
SHALL
Reference Policy
resolves

Interaction summary
  • SHALL support read.

Documentation

If the client supports the PractitionerRole resource, the client SHALL support the IPA profile and the conformance expectations for the PractitionerRole resource.


Source

{
  "resourceType" : "CapabilityStatement",
  "id" : "ipa-client",
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement ipa-client</b></p><a name=\"ipa-client\"> </a><a name=\"hcipa-client\"> </a><a name=\"ipa-client-en-US\"> </a><h2 id=\"title\">International Patient Access Client CapabilityStatement</h2><ul><li>Implementation Guide Version: 1.1.0 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <strong>SHALL</strong> support <code>json</code>, <strong>SHOULD</strong> support <code>xml</code></li><li>Supported Patch Formats: <strong>SHOULD</strong> support <code>application/json-patch+json</code></li><li>Published on: 2023-11-14 </li><li>Published by: HL7 International / Patient Care </li></ul><blockquote class=\"impl-note\"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h3 id=\"shallIGs\">SHALL Support the Following Implementation Guides</h3><ul><li><a href=\"http://hl7.org/fhir/smart-app-launch/STU2/ImplementationGuide-hl7.fhir.uv.smart-app-launch.html\">http://hl7.org/fhir/smart-app-launch/ImplementationGuide/hl7.fhir.uv.smart-app-launch</a></li></ul><h2 id=\"rest\">FHIR RESTful Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"mode1\" class=\"panel-title\">Mode: <code>client</code></h3></div><div class=\"panel-body\"><div><p>The IPA Client <strong>SHALL</strong>:</p>\n<ol>\n<li>Support the IPA conformance expectations for the Patient resource profile.</li>\n<li>Support the IPA conformance expectations for each IPA resource type they support</li>\n<li>Implement the RESTful behavior according to the FHIR specification.</li>\n<li>Support JSON source formats for all IPA interactions.</li>\n</ol>\n<p>The IPA Client <strong>SHOULD</strong>:</p>\n<ol>\n<li>For the purposes of safety, specify the patient id when searching other resources.</li>\n</ol>\n</div><div class=\"lead\"><em>Security</em></div><blockquote><div><ol>\n<li>See the <a href=\"security.html\">General Security Considerations</a> section for requirements and recommendations.</li>\n</ol>\n</div></blockquote><div class=\"lead\"><em>Summary of System-wide Interactions</em></div><ul><li><strong>MAY </strong>support the <code>transaction</code>interaction.</li><li><strong>MAY </strong>support the <code>batch</code>interaction.</li><li><strong>MAY </strong>support the <code>search-system</code>interaction.</li><li><strong>MAY </strong>support the <code>history-system</code>interaction.</li></ul></div></div><h3 id=\"resourcesCap1\">Capabilities by Resource/Profile</h3><h4 id=\"resourcesSummary1\">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class=\"bg-info\">R</span></b>ead, <b><span class=\"bg-info\">S</span></b>earch, <b><span class=\"bg-info\">U</span></b>pdate, and <b><span class=\"bg-info\">C</span></b>reate, are always shown, while <b><span class=\"bg-info\">VR</span></b>ead, <b><span class=\"bg-info\">P</span></b>atch, <b><span class=\"bg-info\">D</span></b>elete, <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">I</span></b>nstance, or <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class=\"table-responsive\"><table class=\"table table-condensed table-hover\"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class=\"text-center\"><b title=\"GET a resource (read interaction)\">R</b></th><th class=\"text-center\"><b title=\"GET all set of resources of the type (search interaction)\">S</b></th><th class=\"text-center\"><b title=\"PUT a new resource version (update interaction)\">U</b></th><th class=\"text-center\"><b title=\"POST a new resource (create interaction)\">C</b></th><th><b title=\"Required and recommended search parameters\">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href=\"#AllergyIntolerance1-1\">AllergyIntolerance</a></td><td><a href=\"StructureDefinition-ipa-allergyintolerance.html\">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-allergyintolerance</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>clinical-status, patient, patient+clinical-status</td><td/><td><code>Provenance:target</code></td><td/></tr><tr><td><a href=\"#Condition1-2\">Condition</a></td><td><a href=\"StructureDefinition-ipa-condition.html\">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-condition</a><br/><em>Additional supported profiles:</em><br/>��<a href=\"StructureDefinition-ipa-problem-list-item.html\">IPA-problem-list-item</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>category, clinical-status, verification-status, code, onset-date, patient, patient+clinical-status, patient+category, patient+category+clinical-status, patient+code, patient+onset-date</td><td/><td><code>Provenance:target</code></td><td/></tr><tr><td><a href=\"#DocumentReference1-3\">DocumentReference</a></td><td><a href=\"StructureDefinition-ipa-documentreference.html\">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-documentreference</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>_id, category, contenttype, date, period, status, type, patient, patient+category, patient+category+date, patient+type, patient+contenttype, patient+status, patient+type+date, patient+type+period</td><td/><td><code>Provenance:target</code></td><td><code>$docref</code></td></tr><tr><td><a href=\"#Immunization1-4\">Immunization</a></td><td><a href=\"StructureDefinition-ipa-immunization.html\">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-immunization</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>date, status, patient, patient+date, patient+status</td><td/><td><code>Provenance:target</code></td><td/></tr><tr><td><a href=\"#Medication1-5\">Medication</a></td><td><a href=\"StructureDefinition-ipa-medication.html\">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medication</a></td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td></td><td/><td><code>Provenance:target</code></td><td/></tr><tr><td><a href=\"#MedicationRequest1-6\">MedicationRequest</a></td><td><a href=\"StructureDefinition-ipa-medicationrequest.html\">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medicationrequest</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>category, code, authoredon, intent, status, patient, patient+intent, patient+intent+authoredon, patient+intent+status</td><td><code>MedicationRequest:medication</code></td><td><code>Provenance:target</code></td><td/></tr><tr><td><a href=\"#MedicationStatement1-7\">MedicationStatement</a></td><td><a href=\"StructureDefinition-ipa-medicationstatement.html\">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medicationstatement</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>status, patient, patient+status</td><td><code>MedicationStatement:medication</code></td><td><code>Provenance:target</code></td><td/></tr><tr><td><a href=\"#Observation1-8\">Observation</a></td><td><a href=\"StructureDefinition-ipa-observation.html\">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-observation</a><br/><em>Additional supported profiles:</em><br/>��<a href=\"http://hl7.org/fhir/R4/vitalsigns.html\">Vital Signs Profile</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>category, code, date, status, patient, patient+category, patient+code, patient+category+date, patient+category+status, patient+code+date</td><td/><td><code>Provenance:target</code></td><td/></tr><tr><td><a href=\"#Patient1-9\">Patient</a></td><td><a href=\"StructureDefinition-ipa-patient.html\">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patient</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>_id, birthdate, family, gender, given, identifier, name, family+gender, birthdate+family, birthdate+name, gender+name</td><td/><td><code>Provenance:target</code></td><td/></tr><tr><td><a href=\"#Practitioner1-10\">Practitioner</a></td><td><a href=\"StructureDefinition-ipa-practitioner.html\">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitioner</a></td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td></td><td/><td><code>Provenance:target</code></td><td/></tr><tr><td><a href=\"#PractitionerRole1-11\">PractitionerRole</a></td><td><a href=\"StructureDefinition-ipa-practitionerrole.html\">http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitionerrole</a></td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td></td><td><code>PractitionerRole:endpoint</code>, <code>PractitionerRole:practitioner</code></td><td><code>Provenance:target</code></td><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"AllergyIntolerance1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD </span>AllergyIntolerance</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"StructureDefinition-ipa-allergyintolerance.html\">IPA-AllergyIntolerance</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/><code>resolves</code></div></div><p/><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>If the client supports the AllergyIntolerance resource, the client <strong>SHALL</strong> support the IPA profile and the conformance expectations for the AllergyIntolerance resource.</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/allergyintolerance.html#search\">patient</a></td><td><code>reference</code></td><td><div><p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values. The server <strong>SHALL</strong> support both.</p>\n</div></td></tr><tr><td><b>MAY</b></td><td><a href=\"http://hl7.org/fhir/R4/allergyintolerance.html#search\">clinical-status</a></td><td><code>token</code></td><td><div><p>active | inactive | resolved</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\"><span class=\"lead\">Combined Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameters</th><th>Types</th></tr></thead><tbody><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/allergyintolerance.html#search\">patient</a>+<a href=\"http://hl7.org/fhir/R4/allergyintolerance.html#search\">clinical-status</a></td><td><code>reference</code>+<code>token</code></td></tr></tbody></table></div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Condition1-2\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD </span>Condition</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"StructureDefinition-ipa-condition.html\">IPA-Condition</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/><code>resolves</code></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-ipa-problem-list-item.html\">IPA-problem-list-item</a></p></div><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>If the client supports the Condition resource, the client <strong>SHALL</strong> support the IPA profile and the conformance expectations for the Condition resource.</p>\n<p>Client applications should be prepared to encounter codes they do not recognize and handle the records\naccordingly. Servers SHOULD populate Condition.code.coding.display and/or Condition.code.text so that\nclients can always at least display the condition even if they do not know the codes that are used. Clients should be careful making use of the <code>code</code> search parameter given that the codes used vary so much.</p>\n<p>Safety Issues:</p>\n<ul>\n<li>Clients SHALL not treat all conditions as if they are part of the patient's current problem list\n<ul>\n<li>Note that some Condition resources may not have these status codes - this is usually due to poor record keeping reflected in legacy data</li>\n<li>Servers SHOULD avoid leaving these status codes missing</li>\n</ul>\n</li>\n<li>Clients SHALL pay attention to the <code>clinicalStatus</code> and <code>verificationStatus</code> and display and process them correctly * Clients SHALL still work safely when the server does not support all the search parameters listed here.</li>\n</ul>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/condition.html#search\">patient</a></td><td><code>reference</code></td><td><div><p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values. The server <strong>SHALL</strong> support both.</p>\n</div></td></tr><tr><td><b>MAY</b></td><td><a href=\"http://hl7.org/fhir/R4/condition.html#search\">category</a></td><td><code>token</code></td><td><div><p>The category of the condition</p>\n</div></td></tr><tr><td><b>MAY</b></td><td><a href=\"http://hl7.org/fhir/R4/condition.html#search\">clinical-status</a></td><td><code>token</code></td><td><div><p>The clinical status of the condition</p>\n</div></td></tr><tr><td><b>MAY</b></td><td><a href=\"http://hl7.org/fhir/R4/condition.html#search\">verification-status</a></td><td><code>token</code></td><td><div><p>The verification status of the condition</p>\n</div></td></tr><tr><td><b>MAY</b></td><td><a href=\"http://hl7.org/fhir/R4/condition.html#search\">code</a></td><td><code>token</code></td><td><div><p>Code for the condition</p>\n</div></td></tr><tr><td><b>MAY</b></td><td><a href=\"http://hl7.org/fhir/R4/condition.html#search\">onset-date</a></td><td><code>date</code></td><td><div><p>Date of onset for the condition</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\"><span class=\"lead\">Combined Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameters</th><th>Types</th></tr></thead><tbody><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/condition.html#search\">patient</a>+<a href=\"http://hl7.org/fhir/R4/condition.html#search\">clinical-status</a></td><td><code>reference</code>+<code>token</code></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/condition.html#search\">patient</a>+<a href=\"http://hl7.org/fhir/R4/condition.html#search\">category</a></td><td><code>reference</code>+<code>token</code></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/condition.html#search\">patient</a>+<a href=\"http://hl7.org/fhir/R4/condition.html#search\">category</a>+<a href=\"http://hl7.org/fhir/R4/condition.html#search\">clinical-status</a></td><td><code>reference</code>+<code>token</code>+<code>token</code></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/condition.html#search\">patient</a>+<a href=\"http://hl7.org/fhir/R4/condition.html#search\">code</a></td><td><code>reference</code>+<code>token</code></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/condition.html#search\">patient</a>+<a href=\"http://hl7.org/fhir/R4/condition.html#search\">onset-date</a></td><td><code>reference</code>+<code>date</code></td></tr></tbody></table></div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"DocumentReference1-3\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD </span>DocumentReference</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"StructureDefinition-ipa-documentreference.html\">IPA-DocumentReference</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/><code>resolves</code></div></div><p/><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>If the client supports the DocumentReference resource, the client <strong>SHALL</strong> support the IPA profile and the conformance expectations for the DocumentReference resource.</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">patient</a></td><td><code>reference</code></td><td><div><p>The client <strong>SHALL</strong> provide at least an id value and <strong>MAY</strong> provide both the Type and id values. The server <strong>SHALL</strong> support both.</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_id</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>MAY</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">category</a></td><td><code>token</code></td><td><div><p>Categorization of document</p>\n</div></td></tr><tr><td><b>MAY</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">contenttype</a></td><td><code>token</code></td><td><div><p>Mime type of the content, may include charset</p>\n</div></td></tr><tr><td><b>MAY</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">date</a></td><td><code>date</code></td><td><div><p>When this document reference was created</p>\n</div></td></tr><tr><td><b>MAY</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">period</a></td><td><code>date</code></td><td><div><p>Time of service that is being documented</p>\n</div></td></tr><tr><td><b>MAY</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">status</a></td><td><code>token</code></td><td><div><p>current | superseded | entered-in-error</p>\n</div></td></tr><tr><td><b>MAY</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">type</a></td><td><code>token</code></td><td><div><p>Kind of document (LOINC if possible)</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\"><span class=\"lead\">Combined Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameters</th><th>Types</th></tr></thead><tbody><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">patient</a>+<a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">category</a></td><td><code>reference</code>+<code>token</code></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">patient</a>+<a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">category</a>+<a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">date</a></td><td><code>reference</code>+<code>token</code>+<code>date</code></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">patient</a>+<a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">type</a></td><td><code>reference</code>+<code>token</code></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">patient</a>+<a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">contenttype</a></td><td><code>reference</code>+<code>token</code></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">patient</a>+<a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">status</a></td><td><code>reference</code>+<code>token</code></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">patient</a>+<a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">type</a>+<a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">date</a></td><td><code>reference</code>+<code>token</code>+<code>date</code></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">patient</a>+<a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">type</a>+<a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">period</a></td><td><code>reference</code>+<code>token</code>+<code>date</code></td></tr></tbody></table></div></div><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Extended Operations</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Operation</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHOULD</b></td><td><a href=\"OperationDefinition-docref.html\">$docref</a></td><td><div><p>A client <strong>SHOULD</strong> be capable of transacting a $docref operation and capable of accessing the document using the using the link provided in the <code>DocumentReference.content.attachment.url</code> element.</p>\n</div></td></tr></tbody></table></div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Immunization1-4\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD </span>Immunization</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"StructureDefinition-ipa-immunization.html\">IPA-Immunization</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/><code>resolves</code></div></div><p/><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>If the client supports the Immunization resource, the client <strong>SHALL</strong> support the IPA profile and the conformance expectations for the Immunization resource.</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/immunization.html#search\">patient</a></td><td><code>reference</code></td><td><div><p>The client <strong>SHALL</strong> provide at least an id value and <strong>MAY</strong> provide both the Type and id values. The server <strong>SHALL</strong> support both.</p>\n</div></td></tr><tr><td><b>MAY</b></td><td><a href=\"http://hl7.org/fhir/R4/immunization.html#search\">date</a></td><td><code>date</code></td><td><div><p>Vaccination (non)-Administration Date</p>\n</div></td></tr><tr><td><b>MAY</b></td><td><a href=\"http://hl7.org/fhir/R4/immunization.html#search\">status</a></td><td><code>token</code></td><td><div><p>Immunization event status</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\"><span class=\"lead\">Combined Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameters</th><th>Types</th></tr></thead><tbody><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/immunization.html#search\">patient</a>+<a href=\"http://hl7.org/fhir/R4/immunization.html#search\">date</a></td><td><code>reference</code>+<code>date</code></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/immunization.html#search\">patient</a>+<a href=\"http://hl7.org/fhir/R4/immunization.html#search\">status</a></td><td><code>reference</code>+<code>token</code></td></tr></tbody></table></div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Medication1-5\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD </span>Medication</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"StructureDefinition-ipa-medication.html\">IPA-Medication</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/><code>resolves</code></div></div><p/><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <code>read</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>If the client supports the the MedicationStatement or MedicationRequest resource, the client <strong>SHALL</strong> support the IPA profile and the conformance expectations for the Medication resource.</p>\n</div></blockquote></div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"MedicationRequest1-6\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD </span>MedicationRequest</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"StructureDefinition-ipa-medicationrequest.html\">IPA-MedicationRequest</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/><code>resolves</code></div></div><p/><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>If the client supports the MedicationRequest resource, the client <strong>SHALL</strong> support the IPA profile and the conformance expectations for the MedicationStatement, MedicationRequest and Medication resource.</p>\n<p>Clients SHALL query for both MedicationStatement and MedicationRequest when fetching patient Medication information.</p>\n<p>The MedicationRequest resources can represent a medication using either a code or refer to the Medication resource. When referencing Medication, the resource may be <a href=\"http://hl7.org/fhir/R4/references.html#contained\">contained</a> or an external resource. The server application <strong>MAY</strong> choose any one way or more than one method, but if an external reference to Medication is used, the server <strong>SHALL</strong> support the <code>_include</code> parameter for searching this element. The client application <strong>SHALL</strong> support all methods. For example, A server <strong>SHALL</strong> be capable of returning all medications for a patient using one of or both:</p>\n<p><code>GET /MedicationStatement?patient=[id]</code></p>\n<p><code>GET /MedicationStatement?patient=[id]&amp;_include=MedicationStatement:medication</code></p>\n<p>When representing a prescribed medication, servers SHOULD use codings at the level of a clinical drug rather than ingredient or dose form (e.g. &quot;loratadine 10mg oral tablet&quot;, rather than a bare ingredient like &quot;loratadine&quot; or a dose form like &quot;loratadine oral tablet&quot;).</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/medicationrequest.html#search\">patient</a></td><td><code>reference</code></td><td><div><p>The client <strong>SHALL</strong> provide at least an id value and <strong>MAY</strong> provide both the Type and id values. The server <strong>SHALL</strong> support both.</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/medicationrequest.html#search\">category</a></td><td><code>token</code></td><td><div><p>Returns prescriptions with different categories</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/medicationrequest.html#search\">code</a></td><td><code>token</code></td><td><div><p>Return prescriptions of this medication code</p>\n</div></td></tr><tr><td><b>MAY</b></td><td><a href=\"http://hl7.org/fhir/R4/medicationrequest.html#search\">authoredon</a></td><td><code>date</code></td><td><div><p>Returns prescriptions written on this date</p>\n</div></td></tr><tr><td><b>MAY</b></td><td><a href=\"http://hl7.org/fhir/R4/medicationrequest.html#search\">intent</a></td><td><code>token</code></td><td><div><p>Return prescriptions with this encounter identifier</p>\n</div></td></tr><tr><td><b>MAY</b></td><td><a href=\"http://hl7.org/fhir/R4/medicationrequest.html#search\">status</a></td><td><code>token</code></td><td><div><p>Status of the prescription</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\"><span class=\"lead\">Combined Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameters</th><th>Types</th></tr></thead><tbody><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/medicationrequest.html#search\">patient</a>+<a href=\"http://hl7.org/fhir/R4/medicationrequest.html#search\">intent</a></td><td><code>reference</code>+<code>token</code></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/medicationrequest.html#search\">patient</a>+<a href=\"http://hl7.org/fhir/R4/medicationrequest.html#search\">intent</a>+<a href=\"http://hl7.org/fhir/R4/medicationrequest.html#search\">authoredon</a></td><td><code>reference</code>+<code>token</code>+<code>date</code></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/medicationrequest.html#search\">patient</a>+<a href=\"http://hl7.org/fhir/R4/medicationrequest.html#search\">intent</a>+<a href=\"http://hl7.org/fhir/R4/medicationrequest.html#search\">status</a></td><td><code>reference</code>+<code>token</code>+<code>token</code></td></tr></tbody></table></div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"MedicationStatement1-7\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD </span>MedicationStatement</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"StructureDefinition-ipa-medicationstatement.html\">IPA-MedicationStatement</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/><code>resolves</code></div></div><p/><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>If the client supports the MedicationStatement resource, the client <strong>SHALL</strong> support the IPA profile and the conformance expectations for the MedicationStatement, MedicationRequest and Medication resource.</p>\n<p>Clients SHALL query for both MedicationStatement and MedicationRequest when fetching patient Medication information.</p>\n<p>The MedicationStatement resources can represent a medication using either a code or refer to the Medication resource. When referencing Medication, the resource may be <a href=\"http://hl7.org/fhir/R4/references.html#contained\">contained</a> or an external resource. The server application <strong>MAY</strong> choose any one way or more than one method, but if an external reference to Medication is used, the server <strong>SHALL</strong> support the <code>_include</code> parameter for searching this element. The client application <strong>SHALL</strong> support all methods.For example, A server <strong>SHALL</strong> be capable of returning all medications for a patient using one of or both:</p>\n<p><code>GET /MedicationStatement?patient=[id]</code></p>\n<p><code>GET/MedicationStatement?patient=[id]&amp;_include=MedicationStatement:medication</code></p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/medicationstatement.html#search\">patient</a></td><td><code>reference</code></td><td><div><p>The client <strong>SHALL</strong> provide at least an id value and <strong>MAY</strong> provide both the Type and id values.</p>\n</div></td></tr><tr><td><b>MAY</b></td><td><a href=\"http://hl7.org/fhir/R4/medicationstatement.html#search\">status</a></td><td><code>token</code></td><td><div><p>Return statements that match the given status</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\"><span class=\"lead\">Combined Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameters</th><th>Types</th></tr></thead><tbody><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/medicationstatement.html#search\">patient</a>+<a href=\"http://hl7.org/fhir/R4/medicationstatement.html#search\">status</a></td><td><code>reference</code>+<code>token</code></td></tr></tbody></table></div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Observation1-8\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD </span>Observation</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"StructureDefinition-ipa-observation.html\">IPA-Observation</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/><code>resolves</code></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"http://hl7.org/fhir/R4/vitalsigns.html\">Vital Signs Profile</a></p></div><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>If the client supports the Observation resource, the client <strong>SHALL</strong> support the IPA profile and the conformance expectations for the Observation resource.</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/observation.html#search\">patient</a></td><td><code>reference</code></td><td><div><p>The client <strong>SHALL</strong> provide at least an id value and <strong>MAY</strong> provide both the Type and id values. The server <strong>SHALL</strong> support both.</p>\n</div></td></tr><tr><td><b>MAY</b></td><td><a href=\"http://hl7.org/fhir/R4/observation.html#search\">category</a></td><td><code>token</code></td><td><div><p>The classification of the type of observation</p>\n</div></td></tr><tr><td><b>MAY</b></td><td><a href=\"http://hl7.org/fhir/R4/observation.html#search\">code</a></td><td><code>token</code></td><td><div><p>The code of the observation type</p>\n</div></td></tr><tr><td><b>MAY</b></td><td><a href=\"http://hl7.org/fhir/R4/observation.html#search\">date</a></td><td><code>date</code></td><td><div><p>Obtained date/time. If the obtained element is a period, a date that falls in the period</p>\n</div></td></tr><tr><td><b>MAY</b></td><td><a href=\"http://hl7.org/fhir/R4/observation.html#search\">status</a></td><td><code>token</code></td><td><div><p>The status of the observation</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\"><span class=\"lead\">Combined Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameters</th><th>Types</th></tr></thead><tbody><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/observation.html#search\">patient</a>+<a href=\"http://hl7.org/fhir/R4/observation.html#search\">category</a></td><td><code>reference</code>+<code>token</code></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/observation.html#search\">patient</a>+<a href=\"http://hl7.org/fhir/R4/observation.html#search\">code</a></td><td><code>reference</code>+<code>token</code></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/observation.html#search\">patient</a>+<a href=\"http://hl7.org/fhir/R4/observation.html#search\">category</a>+<a href=\"http://hl7.org/fhir/R4/observation.html#search\">date</a></td><td><code>reference</code>+<code>token</code>+<code>date</code></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/observation.html#search\">patient</a>+<a href=\"http://hl7.org/fhir/R4/observation.html#search\">category</a>+<a href=\"http://hl7.org/fhir/R4/observation.html#search\">status</a></td><td><code>reference</code>+<code>token</code>+<code>token</code></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/observation.html#search\">patient</a>+<a href=\"http://hl7.org/fhir/R4/observation.html#search\">code</a>+<a href=\"http://hl7.org/fhir/R4/observation.html#search\">date</a></td><td><code>reference</code>+<code>token</code>+<code>date</code></td></tr></tbody></table></div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Patient1-9\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>Patient</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"StructureDefinition-ipa-patient.html\">IPA-Patient</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/><code>resolves</code></div></div><p/><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>Client applications SHALL be able to access the patient record using the following API call:</p>\n<p><code>GET [url]/Patient/[id]</code></p>\n<p>Client application MAY use these search parameters that servers are required to support to access the patient record:</p>\n<ul>\n<li><code>_id</code></li>\n<li><code>identifier</code></li>\n</ul>\n<p>Servers are not required to support any additional search parameters, and clients SHOULD not expect servers to do so.</p>\n<p>Additional rules and guidance for supporting <code>Patient.link</code>:</p>\n<ul>\n<li>The server:\n<ul>\n<li>SHALL have no more than one Patient with a status of active = &quot;true&quot; <em>from the server being queried</em></li>\n<li>MAY include inactive patients on the <em>same server</em></li>\n<li>MAY include inactive or active patients from a <em>different server</em></li>\n<li>When returning a <a href=\"http://hl7.org/fhir/bundle.html\">search Bundle</a> that contains more than one Patient record for the same patient, the Patient record(s) SHALL use the <code>Patient.link</code> attribute to cross-link the Patient resources.</li>\n</ul>\n</li>\n<li>The client:\n<ul>\n<li>SHALL be able to follow the link(s) to the other Patient resource(s) and understand the direction of the link (in other words, which Patient is linked to which other Patient)</li>\n<li>SHALL understand the <code>Patient.link.type</code> code which defines the type of link between this Patient resource and another Patient resource</li>\n<li>SHALL be aware of the linked Patient <code>active</code> flag and that inactive patients may have relevant information</li>\n</ul>\n</li>\n</ul>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_id</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/patient.html#search\">birthdate</a></td><td><code>date</code></td><td><div><p>A client <strong>SHALL</strong> provide a value precise to the <em>day</em>. A server <strong>SHALL</strong> support a value a value precise to the <em>day</em>.</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/patient.html#search\">family</a></td><td><code>string</code></td><td><div/></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/patient.html#search\">gender</a></td><td><code>token</code></td><td><div><p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values. The server <strong>SHALL</strong> support both.</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/patient.html#search\">given</a></td><td><code>string</code></td><td><div/></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/patient.html#search\">identifier</a></td><td><code>token</code></td><td><div><p>The client <strong>SHALL</strong> provide both the system and code values. The server <strong>SHALL NOT</strong> support only code values.</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/patient.html#search\">name</a></td><td><code>string</code></td><td><div/></td></tr></tbody></table></div><div class=\"col-lg-5\"><span class=\"lead\">Combined Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameters</th><th>Types</th></tr></thead><tbody><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/patient.html#search\">family</a>+<a href=\"http://hl7.org/fhir/R4/patient.html#search\">gender</a></td><td><code>string</code>+<code>token</code></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/patient.html#search\">birthdate</a>+<a href=\"http://hl7.org/fhir/R4/patient.html#search\">family</a></td><td><code>date</code>+<code>string</code></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/patient.html#search\">birthdate</a>+<a href=\"http://hl7.org/fhir/R4/patient.html#search\">name</a></td><td><code>date</code>+<code>string</code></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/patient.html#search\">gender</a>+<a href=\"http://hl7.org/fhir/R4/patient.html#search\">name</a></td><td><code>token</code>+<code>string</code></td></tr></tbody></table></div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Practitioner1-10\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD </span>Practitioner</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"StructureDefinition-ipa-practitioner.html\">IPA-Practitioner</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/><code>resolves</code></div></div><p/><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <code>read</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>If the client supports the Practitioner resource, the client <strong>SHALL</strong> support the IPA profile and the conformance expectations for the Practitioner resource.</p>\n</div></blockquote></div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"PractitionerRole1-11\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD </span>PractitionerRole</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"StructureDefinition-ipa-practitionerrole.html\">IPA-PractitionerRole</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/><code>resolves</code></div></div><p/><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <code>read</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>If the client supports the PractitionerRole resource, the client <strong>SHALL</strong> support the IPA profile and the conformance expectations for the PractitionerRole resource.</p>\n</div></blockquote></div></div></div></div></div></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "pc"
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode" : "trial-use"
    }
  ],
  "url" : "http://hl7.org/fhir/uv/ipa/CapabilityStatement/ipa-client",
  "version" : "1.1.0",
  "name" : "InternationalPatientAccessClientAPI",
  "title" : "International Patient Access Client CapabilityStatement",
  "status" : "active",
  "experimental" : false,
  "date" : "2023-11-14",
  "publisher" : "HL7 International / Patient Care",
  "contact" : [
    {
      "name" : "HL7 International / Patient Care",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/patientcare"
        },
        {
          "system" : "email",
          "value" : "patientcare@lists.HL7.org"
        }
      ]
    }
  ],
  "description" : "This CapabilityStatement describes the basic rules for the International Patient Access client actor that initiates a data access request to and retrieves patient data from an IPA Responder. In addition, it lists the client conformance expectations for each resource type documented in IPA. These expectations include supported FHIR profiles, RESTful operations, and search parameters. International Patient Access clients define their capabilities by choosing from this list based on the resource types they need to access.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001",
          "display" : "World"
        }
      ]
    }
  ],
  "copyright" : "Used by permission of HL7 International all rights reserved Creative Commons License",
  "kind" : "requirements",
  "fhirVersion" : "4.0.1",
  "format" : [
    "json",
    "xml"
  ],
  "_format" : [
    {
      "extension" : [
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode" : "SHALL"
        }
      ]
    },
    {
      "extension" : [
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode" : "SHOULD"
        }
      ]
    }
  ],
  "patchFormat" : [
    "application/json-patch+json"
  ],
  "_patchFormat" : [
    {
      "extension" : [
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode" : "SHOULD"
        }
      ]
    }
  ],
  "implementationGuide" : [
    "http://hl7.org/fhir/smart-app-launch/ImplementationGuide/hl7.fhir.uv.smart-app-launch"
  ],
  "_implementationGuide" : [
    {
      "extension" : [
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode" : "SHALL"
        }
      ]
    }
  ],
  "rest" : [
    {
      "mode" : "client",
      "documentation" : "The IPA Client **SHALL**:\n1. Support the IPA conformance expectations for the Patient resource profile.\n1. Support the IPA conformance expectations for each IPA resource type they support\n1. Implement the RESTful behavior according to the FHIR specification.\n1. Support JSON source formats for all IPA interactions.\n\n\nThe IPA Client **SHOULD**:\n1. For the purposes of safety, specify the patient id when searching other resources.",
      "security" : {
        "description" : "1. See the [General Security Considerations](security.html) section for requirements and recommendations."
      },
      "resource" : [
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHOULD"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                },
                {
                  "url" : "required",
                  "valueString" : "patient"
                },
                {
                  "url" : "required",
                  "valueString" : "clinical-status"
                }
              ],
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            }
          ],
          "type" : "AllergyIntolerance",
          "profile" : "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-allergyintolerance",
          "_profile" : {
            "extension" : [
              {
                "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                "valueCode" : "SHALL"
              }
            ]
          },
          "documentation" : "If the client supports the AllergyIntolerance resource, the client **SHALL** support the IPA profile and the conformance expectations for the AllergyIntolerance resource.",
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "read"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "search-type"
            }
          ],
          "updateCreate" : false,
          "conditionalCreate" : false,
          "conditionalUpdate" : false,
          "conditionalDelete" : "not-supported",
          "referencePolicy" : [
            "resolves"
          ],
          "searchRevInclude" : [
            "Provenance:target"
          ],
          "searchParam" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "name" : "clinical-status",
              "definition" : "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-clinical-status",
              "type" : "token",
              "documentation" : "active | inactive | resolved"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "patient",
              "definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
              "type" : "reference",
              "documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values. The server **SHALL** support both."
            }
          ]
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHOULD"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                },
                {
                  "url" : "required",
                  "valueString" : "patient"
                },
                {
                  "url" : "required",
                  "valueString" : "clinical-status"
                }
              ],
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                },
                {
                  "url" : "required",
                  "valueString" : "patient"
                },
                {
                  "url" : "required",
                  "valueString" : "category"
                }
              ],
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                },
                {
                  "url" : "required",
                  "valueString" : "patient"
                },
                {
                  "url" : "required",
                  "valueString" : "category"
                },
                {
                  "url" : "required",
                  "valueString" : "clinical-status"
                }
              ],
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                },
                {
                  "url" : "required",
                  "valueString" : "patient"
                },
                {
                  "url" : "required",
                  "valueString" : "code"
                }
              ],
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                },
                {
                  "url" : "required",
                  "valueString" : "patient"
                },
                {
                  "url" : "required",
                  "valueString" : "onset-date"
                }
              ],
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            }
          ],
          "type" : "Condition",
          "profile" : "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-condition",
          "_profile" : {
            "extension" : [
              {
                "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                "valueCode" : "SHALL"
              }
            ]
          },
          "supportedProfile" : [
            "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-problem-list-item"
          ],
          "_supportedProfile" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ]
            }
          ],
          "documentation" : "If the client supports the Condition resource, the client **SHALL** support the IPA profile and the conformance expectations for the Condition resource.\n\n Client applications should be prepared to encounter codes they do not recognize and handle the records \naccordingly. Servers SHOULD populate Condition.code.coding.display and/or Condition.code.text so that \nclients can always at least display the condition even if they do not know the codes that are used. Clients should be careful making use of the ```code``` search parameter given that the codes used vary so much.\n\nSafety Issues:\n\n* Clients SHALL not treat all conditions as if they are part of the patient's current problem list\n * Note that some Condition resources may not have these status codes - this is usually due to poor record keeping reflected in legacy data\n * Servers SHOULD avoid leaving these status codes missing\n* Clients SHALL pay attention to the ```clinicalStatus``` and ```verificationStatus``` and display and process them correctly * Clients SHALL still work safely when the server does not support all the search parameters listed here.",
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "read"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "search-type"
            }
          ],
          "updateCreate" : false,
          "conditionalCreate" : false,
          "conditionalUpdate" : false,
          "conditionalDelete" : "not-supported",
          "referencePolicy" : [
            "resolves"
          ],
          "searchRevInclude" : [
            "Provenance:target"
          ],
          "searchParam" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "name" : "category",
              "definition" : "http://hl7.org/fhir/SearchParameter/Condition-category",
              "type" : "token",
              "documentation" : "The category of the condition"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "name" : "clinical-status",
              "definition" : "http://hl7.org/fhir/SearchParameter/Condition-clinical-status",
              "type" : "token",
              "documentation" : "The clinical status of the condition"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "name" : "verification-status",
              "definition" : "http://hl7.org/fhir/SearchParameter/Condition-verification-status",
              "type" : "token",
              "documentation" : "The verification status of the condition"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "name" : "code",
              "definition" : "http://hl7.org/fhir/SearchParameter/clinical-code",
              "type" : "token",
              "documentation" : "Code for the condition"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "name" : "onset-date",
              "definition" : "http://hl7.org/fhir/SearchParameter/Condition-onset-date",
              "type" : "date",
              "documentation" : "Date of onset for the condition"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "patient",
              "definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
              "type" : "reference",
              "documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values. The server **SHALL** support both."
            }
          ]
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHOULD"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                },
                {
                  "url" : "required",
                  "valueString" : "patient"
                },
                {
                  "url" : "required",
                  "valueString" : "category"
                }
              ],
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                },
                {
                  "url" : "required",
                  "valueString" : "patient"
                },
                {
                  "url" : "required",
                  "valueString" : "category"
                },
                {
                  "url" : "required",
                  "valueString" : "date"
                }
              ],
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                },
                {
                  "url" : "required",
                  "valueString" : "patient"
                },
                {
                  "url" : "required",
                  "valueString" : "type"
                }
              ],
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                },
                {
                  "url" : "required",
                  "valueString" : "patient"
                },
                {
                  "url" : "required",
                  "valueString" : "contenttype"
                }
              ],
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                },
                {
                  "url" : "required",
                  "valueString" : "patient"
                },
                {
                  "url" : "required",
                  "valueString" : "status"
                }
              ],
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                },
                {
                  "url" : "required",
                  "valueString" : "patient"
                },
                {
                  "url" : "required",
                  "valueString" : "type"
                },
                {
                  "url" : "required",
                  "valueString" : "date"
                }
              ],
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                },
                {
                  "url" : "required",
                  "valueString" : "patient"
                },
                {
                  "url" : "required",
                  "valueString" : "type"
                },
                {
                  "url" : "required",
                  "valueString" : "period"
                }
              ],
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            }
          ],
          "type" : "DocumentReference",
          "profile" : "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-documentreference",
          "_profile" : {
            "extension" : [
              {
                "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                "valueCode" : "SHALL"
              }
            ]
          },
          "documentation" : "If the client supports the DocumentReference resource, the client **SHALL** support the IPA profile and the conformance expectations for the DocumentReference resource.",
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "read"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "search-type"
            }
          ],
          "updateCreate" : false,
          "conditionalCreate" : false,
          "conditionalUpdate" : false,
          "conditionalDelete" : "not-supported",
          "referencePolicy" : [
            "resolves"
          ],
          "searchRevInclude" : [
            "Provenance:target"
          ],
          "searchParam" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "name" : "_id",
              "definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
              "type" : "token"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "name" : "category",
              "definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-category",
              "type" : "token",
              "documentation" : "Categorization of document"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "name" : "contenttype",
              "definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-category",
              "type" : "token",
              "documentation" : "Mime type of the content, may include charset"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "name" : "date",
              "definition" : "http://hl7.org/fhir/SearchParameter/clinical-date",
              "type" : "date",
              "documentation" : "When this document reference was created"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "name" : "period",
              "definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-period",
              "type" : "date",
              "documentation" : "Time of service that is being documented"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "name" : "status",
              "definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-status",
              "type" : "token",
              "documentation" : "current | superseded | entered-in-error"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "name" : "type",
              "definition" : "http://hl7.org/fhir/SearchParameter/clinical-type",
              "type" : "token",
              "documentation" : "Kind of document (LOINC if possible)"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "patient",
              "definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
              "type" : "reference",
              "documentation" : "The client **SHALL** provide at least an id value and **MAY** provide both the Type and id values. The server **SHALL** support both."
            }
          ],
          "operation" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "name" : "docref",
              "definition" : "http://hl7.org/fhir/uv/ipa/OperationDefinition/docref",
              "documentation" : "A client **SHOULD** be capable of transacting a $docref operation and capable of accessing the document using the using the link provided in the `DocumentReference.content.attachment.url` element."
            }
          ]
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHOULD"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                },
                {
                  "url" : "required",
                  "valueString" : "patient"
                },
                {
                  "url" : "required",
                  "valueString" : "date"
                }
              ],
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                },
                {
                  "url" : "required",
                  "valueString" : "patient"
                },
                {
                  "url" : "required",
                  "valueString" : "status"
                }
              ],
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            }
          ],
          "type" : "Immunization",
          "profile" : "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-immunization",
          "_profile" : {
            "extension" : [
              {
                "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                "valueCode" : "SHALL"
              }
            ]
          },
          "documentation" : "If the client supports the Immunization resource, the client **SHALL** support the IPA profile and the conformance expectations for the Immunization resource.",
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "read"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "search-type"
            }
          ],
          "updateCreate" : false,
          "conditionalCreate" : false,
          "conditionalUpdate" : false,
          "conditionalDelete" : "not-supported",
          "referencePolicy" : [
            "resolves"
          ],
          "searchRevInclude" : [
            "Provenance:target"
          ],
          "searchParam" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "name" : "date",
              "definition" : "http://hl7.org/fhir/SearchParameter/clinical-date",
              "type" : "date",
              "documentation" : "Vaccination (non)-Administration Date"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "name" : "status",
              "definition" : "http://hl7.org/fhir/SearchParameter/Immunization-status",
              "type" : "token",
              "documentation" : "Immunization event status"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "patient",
              "definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
              "type" : "reference",
              "documentation" : "The client **SHALL** provide at least an id value and **MAY** provide both the Type and id values. The server **SHALL** support both."
            }
          ]
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHOULD"
            }
          ],
          "type" : "Medication",
          "profile" : "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medication",
          "_profile" : {
            "extension" : [
              {
                "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                "valueCode" : "SHALL"
              }
            ]
          },
          "documentation" : "If the client supports the the MedicationStatement or MedicationRequest resource, the client **SHALL** support the IPA profile and the conformance expectations for the Medication resource.",
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "read"
            }
          ],
          "updateCreate" : false,
          "conditionalCreate" : false,
          "conditionalUpdate" : false,
          "conditionalDelete" : "not-supported",
          "referencePolicy" : [
            "resolves"
          ],
          "searchRevInclude" : [
            "Provenance:target"
          ]
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHOULD"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                },
                {
                  "url" : "required",
                  "valueString" : "patient"
                },
                {
                  "url" : "required",
                  "valueString" : "intent"
                }
              ],
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                },
                {
                  "url" : "required",
                  "valueString" : "patient"
                },
                {
                  "url" : "required",
                  "valueString" : "intent"
                },
                {
                  "url" : "required",
                  "valueString" : "authoredon"
                }
              ],
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                },
                {
                  "url" : "required",
                  "valueString" : "patient"
                },
                {
                  "url" : "required",
                  "valueString" : "intent"
                },
                {
                  "url" : "required",
                  "valueString" : "status"
                }
              ],
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            }
          ],
          "type" : "MedicationRequest",
          "profile" : "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medicationrequest",
          "_profile" : {
            "extension" : [
              {
                "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                "valueCode" : "SHALL"
              }
            ]
          },
          "documentation" : "If the client supports the MedicationRequest resource, the client **SHALL** support the IPA profile and the conformance expectations for the MedicationStatement, MedicationRequest and Medication resource.\n\n\nClients SHALL query for both MedicationStatement and MedicationRequest when fetching patient Medication information.\n\n\nThe MedicationRequest resources can represent a medication using either a code or refer to the Medication resource. When referencing Medication, the resource may be [contained](http://hl7.org/fhir/R4/references.html#contained) or an external resource. The server application **MAY** choose any one way or more than one method, but if an external reference to Medication is used, the server **SHALL** support the `_include` parameter for searching this element. The client application **SHALL** support all methods. For example, A server **SHALL** be capable of returning all medications for a patient using one of or both:\n\n\n\n `GET /MedicationStatement?patient=[id]`\n\n\n\n `GET\n/MedicationStatement?patient=[id]&_include=MedicationStatement:medication`\n\n\nWhen representing a prescribed medication, servers SHOULD use codings at the level of a clinical drug rather than ingredient or dose form (e.g. \"loratadine 10mg oral tablet\", rather than a bare ingredient like \"loratadine\" or a dose form like \"loratadine oral tablet\").",
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "read"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "search-type"
            }
          ],
          "updateCreate" : false,
          "conditionalCreate" : false,
          "conditionalUpdate" : false,
          "conditionalDelete" : "not-supported",
          "referencePolicy" : [
            "resolves"
          ],
          "searchInclude" : [
            "MedicationRequest:medication"
          ],
          "searchRevInclude" : [
            "Provenance:target"
          ],
          "searchParam" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "name" : "category",
              "definition" : "http://hl7.org/fhir/SearchParameter/MedicationRequest-category",
              "type" : "token",
              "documentation" : "Returns prescriptions with different categories"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "name" : "code",
              "definition" : "http://hl7.org/fhir/SearchParameter/clinical-code",
              "type" : "token",
              "documentation" : "Return prescriptions of this medication code"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "name" : "authoredon",
              "definition" : "http://hl7.org/fhir/SearchParameter/MedicationRequest-authoredon",
              "type" : "date",
              "documentation" : "Returns prescriptions written on this date"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "name" : "intent",
              "definition" : "http://hl7.org/fhir/SearchParameter/MedicationRequest-intent",
              "type" : "token",
              "documentation" : "Return prescriptions with this encounter identifier"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "name" : "status",
              "definition" : "http://hl7.org/fhir/SearchParameter/medications-status",
              "type" : "token",
              "documentation" : "Status of the prescription"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "patient",
              "definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
              "type" : "reference",
              "documentation" : "The client **SHALL** provide at least an id value and **MAY** provide both the Type and id values. The server **SHALL** support both."
            }
          ]
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHOULD"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                },
                {
                  "url" : "required",
                  "valueString" : "patient"
                },
                {
                  "url" : "required",
                  "valueString" : "status"
                }
              ],
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            }
          ],
          "type" : "MedicationStatement",
          "profile" : "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medicationstatement",
          "_profile" : {
            "extension" : [
              {
                "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                "valueCode" : "SHALL"
              }
            ]
          },
          "documentation" : "If the client supports the MedicationStatement resource, the client **SHALL** support the IPA profile and the conformance expectations for the MedicationStatement, MedicationRequest and Medication resource.\n\n\nClients SHALL query for both MedicationStatement and MedicationRequest when fetching patient Medication information.\n\n\nThe MedicationStatement resources can represent a medication using either a code or refer to the Medication resource. When referencing Medication, the resource may be [contained](http://hl7.org/fhir/R4/references.html#contained) or an external resource. The server application **MAY** choose any one way or more than one method, but if an external reference to Medication is used, the server **SHALL** support the `_include` parameter for searching this element. The client application **SHALL** support all methods.For example, A server **SHALL** be capable of returning all medications for a patient using one of or both:\n\n\n\n `GET /MedicationStatement?patient=[id]`\n\n\n\n `GET/MedicationStatement?patient=[id]&_include=MedicationStatement:medication`",
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "read"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "search-type"
            }
          ],
          "updateCreate" : false,
          "conditionalCreate" : false,
          "conditionalUpdate" : false,
          "conditionalDelete" : "not-supported",
          "referencePolicy" : [
            "resolves"
          ],
          "searchInclude" : [
            "MedicationStatement:medication"
          ],
          "searchRevInclude" : [
            "Provenance:target"
          ],
          "searchParam" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "name" : "status",
              "definition" : "http://hl7.org/fhir/SearchParameter/medications-status",
              "type" : "token",
              "documentation" : "Return statements that match the given status"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "patient",
              "definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
              "type" : "reference",
              "documentation" : "The client **SHALL** provide at least an id value and **MAY** provide both the Type and id values."
            }
          ]
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHOULD"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                },
                {
                  "url" : "required",
                  "valueString" : "patient"
                },
                {
                  "url" : "required",
                  "valueString" : "category"
                }
              ],
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                },
                {
                  "url" : "required",
                  "valueString" : "patient"
                },
                {
                  "url" : "required",
                  "valueString" : "code"
                }
              ],
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                },
                {
                  "url" : "required",
                  "valueString" : "patient"
                },
                {
                  "url" : "required",
                  "valueString" : "category"
                },
                {
                  "url" : "required",
                  "valueString" : "date"
                }
              ],
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                },
                {
                  "url" : "required",
                  "valueString" : "patient"
                },
                {
                  "url" : "required",
                  "valueString" : "category"
                },
                {
                  "url" : "required",
                  "valueString" : "status"
                }
              ],
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                },
                {
                  "url" : "required",
                  "valueString" : "patient"
                },
                {
                  "url" : "required",
                  "valueString" : "code"
                },
                {
                  "url" : "required",
                  "valueString" : "date"
                }
              ],
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            }
          ],
          "type" : "Observation",
          "profile" : "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-observation",
          "_profile" : {
            "extension" : [
              {
                "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                "valueCode" : "SHALL"
              }
            ]
          },
          "supportedProfile" : [
            "http://hl7.org/fhir/StructureDefinition/vitalsigns"
          ],
          "_supportedProfile" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ]
            }
          ],
          "documentation" : "If the client supports the Observation resource, the client **SHALL** support the IPA profile and the conformance expectations for the Observation resource.",
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "read"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "search-type"
            }
          ],
          "updateCreate" : false,
          "conditionalCreate" : false,
          "conditionalUpdate" : false,
          "conditionalDelete" : "not-supported",
          "referencePolicy" : [
            "resolves"
          ],
          "searchRevInclude" : [
            "Provenance:target"
          ],
          "searchParam" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "name" : "category",
              "definition" : "http://hl7.org/fhir/SearchParameter/Observation-category",
              "type" : "token",
              "documentation" : "The classification of the type of observation"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "name" : "code",
              "definition" : "http://hl7.org/fhir/SearchParameter/clinical-code",
              "type" : "token",
              "documentation" : "The code of the observation type"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "name" : "date",
              "definition" : "http://hl7.org/fhir/SearchParameter/clinical-date",
              "type" : "date",
              "documentation" : "Obtained date/time. If the obtained element is a period, a date that falls in the period"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "name" : "status",
              "definition" : "http://hl7.org/fhir/SearchParameter/Observation-status",
              "type" : "token",
              "documentation" : "The status of the observation"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "patient",
              "definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
              "type" : "reference",
              "documentation" : "The client **SHALL** provide at least an id value and **MAY** provide both the Type and id values. The server **SHALL** support both."
            }
          ]
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHALL"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                },
                {
                  "url" : "required",
                  "valueString" : "family"
                },
                {
                  "url" : "required",
                  "valueString" : "gender"
                }
              ],
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                },
                {
                  "url" : "required",
                  "valueString" : "birthdate"
                },
                {
                  "url" : "required",
                  "valueString" : "family"
                }
              ],
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                },
                {
                  "url" : "required",
                  "valueString" : "birthdate"
                },
                {
                  "url" : "required",
                  "valueString" : "name"
                }
              ],
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                },
                {
                  "url" : "required",
                  "valueString" : "gender"
                },
                {
                  "url" : "required",
                  "valueString" : "name"
                }
              ],
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            }
          ],
          "type" : "Patient",
          "profile" : "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patient",
          "_profile" : {
            "extension" : [
              {
                "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                "valueCode" : "SHALL"
              }
            ]
          },
          "documentation" : "Client applications SHALL be able to access the patient record using the following API call:\n\n`GET [url]/Patient/[id]`\n\nClient application MAY use these search parameters that servers are required to support to access the patient record:\n\n - `_id`\n - `identifier`\n\nServers are not required to support any additional search parameters, and clients SHOULD not expect servers to do so.\n\nAdditional rules and guidance for supporting `Patient.link`:\n\n- The server:\n - SHALL have no more than one Patient with a status of active = \"true\" *from the server being queried* \n - MAY include inactive patients on the *same server*\n - MAY include inactive or active patients from a *different server*\n - When returning a [search Bundle](http://hl7.org/fhir/bundle.html) that contains more than one Patient record for the same patient, the Patient record(s) SHALL use the `Patient.link` attribute to cross-link the Patient resources.\n- The client:\n - SHALL be able to follow the link(s) to the other Patient resource(s) and understand the direction of the link (in other words, which Patient is linked to which other Patient)\n - SHALL understand the `Patient.link.type` code which defines the type of link between this Patient resource and another Patient resource\n - SHALL be aware of the linked Patient `active` flag and that inactive patients may have relevant information",
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "read"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "search-type"
            }
          ],
          "updateCreate" : false,
          "conditionalCreate" : false,
          "conditionalUpdate" : false,
          "conditionalDelete" : "not-supported",
          "referencePolicy" : [
            "resolves"
          ],
          "searchRevInclude" : [
            "Provenance:target"
          ],
          "searchParam" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "name" : "_id",
              "definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
              "type" : "token"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "name" : "birthdate",
              "definition" : "http://hl7.org/fhir/SearchParameter/individual-birthdate",
              "type" : "date",
              "documentation" : "A client **SHALL** provide a value precise to the *day*. A server **SHALL** support a value a value precise to the *day*."
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "name" : "family",
              "definition" : "http://hl7.org/fhir/SearchParameter/individual-family",
              "type" : "string"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "name" : "gender",
              "definition" : "http://hl7.org/fhir/SearchParameter/individual-gender",
              "type" : "token",
              "documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both."
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "name" : "given",
              "definition" : "http://hl7.org/fhir/SearchParameter/individual-given",
              "type" : "string"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "name" : "identifier",
              "definition" : "http://hl7.org/fhir/SearchParameter/Patient-identifier",
              "type" : "token",
              "documentation" : "The client **SHALL** provide both the system and code values. The server **SHALL NOT** support only code values."
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "name" : "name",
              "definition" : "http://hl7.org/fhir/SearchParameter/Patient-name",
              "type" : "string"
            }
          ]
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHOULD"
            }
          ],
          "type" : "Practitioner",
          "profile" : "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitioner",
          "_profile" : {
            "extension" : [
              {
                "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                "valueCode" : "SHALL"
              }
            ]
          },
          "documentation" : "If the client supports the Practitioner resource, the client **SHALL** support the IPA profile and the conformance expectations for the Practitioner resource.",
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "read"
            }
          ],
          "updateCreate" : false,
          "conditionalCreate" : false,
          "conditionalUpdate" : false,
          "conditionalDelete" : "not-supported",
          "referencePolicy" : [
            "resolves"
          ],
          "searchRevInclude" : [
            "Provenance:target"
          ]
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHOULD"
            }
          ],
          "type" : "PractitionerRole",
          "profile" : "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitionerrole",
          "_profile" : {
            "extension" : [
              {
                "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                "valueCode" : "SHALL"
              }
            ]
          },
          "documentation" : "If the client supports the PractitionerRole resource, the client **SHALL** support the IPA profile and the conformance expectations for the PractitionerRole resource.",
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "read"
            }
          ],
          "updateCreate" : false,
          "conditionalCreate" : false,
          "conditionalUpdate" : false,
          "conditionalDelete" : "not-supported",
          "referencePolicy" : [
            "resolves"
          ],
          "searchInclude" : [
            "PractitionerRole:endpoint",
            "PractitionerRole:practitioner"
          ],
          "searchRevInclude" : [
            "Provenance:target"
          ]
        }
      ],
      "interaction" : [
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "MAY"
            }
          ],
          "code" : "transaction"
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "MAY"
            }
          ],
          "code" : "batch"
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "MAY"
            }
          ],
          "code" : "search-system"
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "MAY"
            }
          ],
          "code" : "history-system"
        }
      ]
    }
  ]
}

XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.